<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2012 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.collect;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import com.google.common.annotations.Beta;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Iterator;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.NavigableSet;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.SortedSet;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * A navigable set which forwards all its method calls to another navigable set. Subclasses should<a name="line.26"></a>
<span class="sourceLineNo">027</span> * override one or more methods to modify the behavior of the backing set as desired per the &lt;a<a name="line.27"></a>
<span class="sourceLineNo">028</span> * href="http://en.wikipedia.org/wiki/Decorator_pattern"&gt;decorator pattern&lt;/a&gt;.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;&lt;i&gt;Warning:&lt;/i&gt; The methods of {@code ForwardingNavigableSet} forward &lt;i&gt;indiscriminately&lt;/i&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * to the methods of the delegate. For example, overriding {@link #add} alone &lt;i&gt;will not&lt;/i&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * change the behavior of {@link #addAll}, which can lead to unexpected behavior. In this case, you<a name="line.32"></a>
<span class="sourceLineNo">033</span> * should override {@code addAll} as well, either providing your own implementation, or delegating<a name="line.33"></a>
<span class="sourceLineNo">034</span> * to the provided {@code standardAddAll} method.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;p&gt;Each of the {@code standard} methods uses the set's comparator (or the natural ordering of<a name="line.36"></a>
<span class="sourceLineNo">037</span> * the elements, if there is no comparator) to test element equality. As a result, if the<a name="line.37"></a>
<span class="sourceLineNo">038</span> * comparator is not consistent with equals, some of the standard implementations may violate the<a name="line.38"></a>
<span class="sourceLineNo">039</span> * {@code Set} contract.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;p&gt;The {@code standard} methods and the collection views they return are not guaranteed to be<a name="line.41"></a>
<span class="sourceLineNo">042</span> * thread-safe, even when all of the methods that they depend on are thread-safe.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @author Louis Wasserman<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @since 12.0<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span>@Beta<a name="line.47"></a>
<span class="sourceLineNo">048</span>public abstract class ForwardingNavigableSet&lt;E&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span>    extends ForwardingSortedSet&lt;E&gt; implements NavigableSet&lt;E&gt; {<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span>  /** Constructor for use by subclasses. */<a name="line.51"></a>
<span class="sourceLineNo">052</span>  protected ForwardingNavigableSet() {}<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>  @Override<a name="line.54"></a>
<span class="sourceLineNo">055</span>  protected abstract NavigableSet&lt;E&gt; delegate();<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span>  @Override<a name="line.57"></a>
<span class="sourceLineNo">058</span>  public E lower(E e) {<a name="line.58"></a>
<span class="sourceLineNo">059</span>    return delegate().lower(e);<a name="line.59"></a>
<span class="sourceLineNo">060</span>  }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>  /**<a name="line.62"></a>
<span class="sourceLineNo">063</span>   * A sensible definition of {@link #lower} in terms of the {@code descendingIterator} method of<a name="line.63"></a>
<span class="sourceLineNo">064</span>   * {@link #headSet(Object, boolean)}. If you override {@link #headSet(Object, boolean)}, you may<a name="line.64"></a>
<span class="sourceLineNo">065</span>   * wish to override {@link #lower} to forward to this implementation.<a name="line.65"></a>
<span class="sourceLineNo">066</span>   */<a name="line.66"></a>
<span class="sourceLineNo">067</span>  protected E standardLower(E e) {<a name="line.67"></a>
<span class="sourceLineNo">068</span>    return Iterators.getNext(headSet(e, false).descendingIterator(), null);<a name="line.68"></a>
<span class="sourceLineNo">069</span>  }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>  @Override<a name="line.71"></a>
<span class="sourceLineNo">072</span>  public E floor(E e) {<a name="line.72"></a>
<span class="sourceLineNo">073</span>    return delegate().floor(e);<a name="line.73"></a>
<span class="sourceLineNo">074</span>  }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>  /**<a name="line.76"></a>
<span class="sourceLineNo">077</span>   * A sensible definition of {@link #floor} in terms of the {@code descendingIterator} method of<a name="line.77"></a>
<span class="sourceLineNo">078</span>   * {@link #headSet(Object, boolean)}. If you override {@link #headSet(Object, boolean)}, you may<a name="line.78"></a>
<span class="sourceLineNo">079</span>   * wish to override {@link #floor} to forward to this implementation.<a name="line.79"></a>
<span class="sourceLineNo">080</span>   */<a name="line.80"></a>
<span class="sourceLineNo">081</span>  protected E standardFloor(E e) {<a name="line.81"></a>
<span class="sourceLineNo">082</span>    return Iterators.getNext(headSet(e, true).descendingIterator(), null);<a name="line.82"></a>
<span class="sourceLineNo">083</span>  }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>  @Override<a name="line.85"></a>
<span class="sourceLineNo">086</span>  public E ceiling(E e) {<a name="line.86"></a>
<span class="sourceLineNo">087</span>    return delegate().ceiling(e);<a name="line.87"></a>
<span class="sourceLineNo">088</span>  }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>  /**<a name="line.90"></a>
<span class="sourceLineNo">091</span>   * A sensible definition of {@link #ceiling} in terms of the {@code iterator} method of<a name="line.91"></a>
<span class="sourceLineNo">092</span>   * {@link #tailSet(Object, boolean)}. If you override {@link #tailSet(Object, boolean)}, you may<a name="line.92"></a>
<span class="sourceLineNo">093</span>   * wish to override {@link #ceiling} to forward to this implementation.<a name="line.93"></a>
<span class="sourceLineNo">094</span>   */<a name="line.94"></a>
<span class="sourceLineNo">095</span>  protected E standardCeiling(E e) {<a name="line.95"></a>
<span class="sourceLineNo">096</span>    return Iterators.getNext(tailSet(e, true).iterator(), null);<a name="line.96"></a>
<span class="sourceLineNo">097</span>  }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>  @Override<a name="line.99"></a>
<span class="sourceLineNo">100</span>  public E higher(E e) {<a name="line.100"></a>
<span class="sourceLineNo">101</span>    return delegate().higher(e);<a name="line.101"></a>
<span class="sourceLineNo">102</span>  }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span>  /**<a name="line.104"></a>
<span class="sourceLineNo">105</span>   * A sensible definition of {@link #higher} in terms of the {@code iterator} method of<a name="line.105"></a>
<span class="sourceLineNo">106</span>   * {@link #tailSet(Object, boolean)}. If you override {@link #tailSet(Object, boolean)}, you may<a name="line.106"></a>
<span class="sourceLineNo">107</span>   * wish to override {@link #higher} to forward to this implementation.<a name="line.107"></a>
<span class="sourceLineNo">108</span>   */<a name="line.108"></a>
<span class="sourceLineNo">109</span>  protected E standardHigher(E e) {<a name="line.109"></a>
<span class="sourceLineNo">110</span>    return Iterators.getNext(tailSet(e, false).iterator(), null);<a name="line.110"></a>
<span class="sourceLineNo">111</span>  }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>  @Override<a name="line.113"></a>
<span class="sourceLineNo">114</span>  public E pollFirst() {<a name="line.114"></a>
<span class="sourceLineNo">115</span>    return delegate().pollFirst();<a name="line.115"></a>
<span class="sourceLineNo">116</span>  }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span>  /**<a name="line.118"></a>
<span class="sourceLineNo">119</span>   * A sensible definition of {@link #pollFirst} in terms of the {@code iterator} method. If you<a name="line.119"></a>
<span class="sourceLineNo">120</span>   * override {@link #iterator} you may wish to override {@link #pollFirst} to forward to this<a name="line.120"></a>
<span class="sourceLineNo">121</span>   * implementation.<a name="line.121"></a>
<span class="sourceLineNo">122</span>   */<a name="line.122"></a>
<span class="sourceLineNo">123</span>  protected E standardPollFirst() {<a name="line.123"></a>
<span class="sourceLineNo">124</span>    return Iterators.pollNext(iterator());<a name="line.124"></a>
<span class="sourceLineNo">125</span>  }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span>  @Override<a name="line.127"></a>
<span class="sourceLineNo">128</span>  public E pollLast() {<a name="line.128"></a>
<span class="sourceLineNo">129</span>    return delegate().pollLast();<a name="line.129"></a>
<span class="sourceLineNo">130</span>  }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span>  /**<a name="line.132"></a>
<span class="sourceLineNo">133</span>   * A sensible definition of {@link #pollLast} in terms of the {@code descendingIterator} method.<a name="line.133"></a>
<span class="sourceLineNo">134</span>   * If you override {@link #descendingIterator} you may wish to override {@link #pollLast} to<a name="line.134"></a>
<span class="sourceLineNo">135</span>   * forward to this implementation.<a name="line.135"></a>
<span class="sourceLineNo">136</span>   */<a name="line.136"></a>
<span class="sourceLineNo">137</span>  protected E standardPollLast() {<a name="line.137"></a>
<span class="sourceLineNo">138</span>    return Iterators.pollNext(delegate().descendingIterator());<a name="line.138"></a>
<span class="sourceLineNo">139</span>  }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>  protected E standardFirst() {<a name="line.141"></a>
<span class="sourceLineNo">142</span>    return iterator().next();<a name="line.142"></a>
<span class="sourceLineNo">143</span>  }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>  protected E standardLast() {<a name="line.145"></a>
<span class="sourceLineNo">146</span>    return descendingIterator().next();<a name="line.146"></a>
<span class="sourceLineNo">147</span>  }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span>  @Override<a name="line.149"></a>
<span class="sourceLineNo">150</span>  public NavigableSet&lt;E&gt; descendingSet() {<a name="line.150"></a>
<span class="sourceLineNo">151</span>    return delegate().descendingSet();<a name="line.151"></a>
<span class="sourceLineNo">152</span>  }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span>  /**<a name="line.154"></a>
<span class="sourceLineNo">155</span>   * A sensible implementation of {@link NavigableSet#descendingSet} in terms of the other methods<a name="line.155"></a>
<span class="sourceLineNo">156</span>   * of {@link NavigableSet}, notably including {@link NavigableSet#descendingIterator}.<a name="line.156"></a>
<span class="sourceLineNo">157</span>   *<a name="line.157"></a>
<span class="sourceLineNo">158</span>   * &lt;p&gt;In many cases, you may wish to override {@link ForwardingNavigableSet#descendingSet} to<a name="line.158"></a>
<span class="sourceLineNo">159</span>   * forward to this implementation or a subclass thereof.<a name="line.159"></a>
<span class="sourceLineNo">160</span>   *<a name="line.160"></a>
<span class="sourceLineNo">161</span>   * @since 12.0<a name="line.161"></a>
<span class="sourceLineNo">162</span>   */<a name="line.162"></a>
<span class="sourceLineNo">163</span>  @Beta<a name="line.163"></a>
<span class="sourceLineNo">164</span>  protected class StandardDescendingSet extends Sets.DescendingSet&lt;E&gt; {<a name="line.164"></a>
<span class="sourceLineNo">165</span>    /** Constructor for use by subclasses. */<a name="line.165"></a>
<span class="sourceLineNo">166</span>    public StandardDescendingSet() {<a name="line.166"></a>
<span class="sourceLineNo">167</span>      super(ForwardingNavigableSet.this);<a name="line.167"></a>
<span class="sourceLineNo">168</span>    }<a name="line.168"></a>
<span class="sourceLineNo">169</span>  }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span>  @Override<a name="line.171"></a>
<span class="sourceLineNo">172</span>  public Iterator&lt;E&gt; descendingIterator() {<a name="line.172"></a>
<span class="sourceLineNo">173</span>    return delegate().descendingIterator();<a name="line.173"></a>
<span class="sourceLineNo">174</span>  }<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span>  @Override<a name="line.176"></a>
<span class="sourceLineNo">177</span>  public NavigableSet&lt;E&gt; subSet(<a name="line.177"></a>
<span class="sourceLineNo">178</span>      E fromElement,<a name="line.178"></a>
<span class="sourceLineNo">179</span>      boolean fromInclusive,<a name="line.179"></a>
<span class="sourceLineNo">180</span>      E toElement,<a name="line.180"></a>
<span class="sourceLineNo">181</span>      boolean toInclusive) {<a name="line.181"></a>
<span class="sourceLineNo">182</span>    return delegate().subSet(fromElement, fromInclusive, toElement, toInclusive);<a name="line.182"></a>
<span class="sourceLineNo">183</span>  }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span>  /**<a name="line.185"></a>
<span class="sourceLineNo">186</span>   * A sensible definition of {@link #subSet(Object, boolean, Object, boolean)} in terms of the<a name="line.186"></a>
<span class="sourceLineNo">187</span>   * {@code headSet} and {@code tailSet} methods. In many cases, you may wish to override<a name="line.187"></a>
<span class="sourceLineNo">188</span>   * {@link #subSet(Object, boolean, Object, boolean)} to forward to this implementation.<a name="line.188"></a>
<span class="sourceLineNo">189</span>   */<a name="line.189"></a>
<span class="sourceLineNo">190</span>  protected NavigableSet&lt;E&gt; standardSubSet(<a name="line.190"></a>
<span class="sourceLineNo">191</span>      E fromElement,<a name="line.191"></a>
<span class="sourceLineNo">192</span>      boolean fromInclusive,<a name="line.192"></a>
<span class="sourceLineNo">193</span>      E toElement,<a name="line.193"></a>
<span class="sourceLineNo">194</span>      boolean toInclusive) {<a name="line.194"></a>
<span class="sourceLineNo">195</span>    return tailSet(fromElement, fromInclusive).headSet(toElement, toInclusive);<a name="line.195"></a>
<span class="sourceLineNo">196</span>  }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span>  /**<a name="line.198"></a>
<span class="sourceLineNo">199</span>   * A sensible definition of {@link #subSet(Object, Object)} in terms of the<a name="line.199"></a>
<span class="sourceLineNo">200</span>   * {@link #subSet(Object, boolean, Object, boolean)} method. If you override<a name="line.200"></a>
<span class="sourceLineNo">201</span>   * {@link #subSet(Object, boolean, Object, boolean)}, you may wish to override<a name="line.201"></a>
<span class="sourceLineNo">202</span>   * {@link #subSet(Object, Object)} to forward to this implementation.<a name="line.202"></a>
<span class="sourceLineNo">203</span>   */<a name="line.203"></a>
<span class="sourceLineNo">204</span>  @Override<a name="line.204"></a>
<span class="sourceLineNo">205</span>  protected SortedSet&lt;E&gt; standardSubSet(E fromElement, E toElement) {<a name="line.205"></a>
<span class="sourceLineNo">206</span>    return subSet(fromElement, true, toElement, false);<a name="line.206"></a>
<span class="sourceLineNo">207</span>  }<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span>  @Override<a name="line.209"></a>
<span class="sourceLineNo">210</span>  public NavigableSet&lt;E&gt; headSet(E toElement, boolean inclusive) {<a name="line.210"></a>
<span class="sourceLineNo">211</span>    return delegate().headSet(toElement, inclusive);<a name="line.211"></a>
<span class="sourceLineNo">212</span>  }<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span>  /**<a name="line.214"></a>
<span class="sourceLineNo">215</span>   * A sensible definition of {@link #headSet(Object)} in terms of the<a name="line.215"></a>
<span class="sourceLineNo">216</span>   * {@link #headSet(Object, boolean)} method. If you override<a name="line.216"></a>
<span class="sourceLineNo">217</span>   * {@link #headSet(Object, boolean)}, you may wish to override<a name="line.217"></a>
<span class="sourceLineNo">218</span>   * {@link #headSet(Object)} to forward to this implementation.<a name="line.218"></a>
<span class="sourceLineNo">219</span>   */<a name="line.219"></a>
<span class="sourceLineNo">220</span>  protected SortedSet&lt;E&gt; standardHeadSet(E toElement) {<a name="line.220"></a>
<span class="sourceLineNo">221</span>    return headSet(toElement, false);<a name="line.221"></a>
<span class="sourceLineNo">222</span>  }<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span>  @Override<a name="line.224"></a>
<span class="sourceLineNo">225</span>  public NavigableSet&lt;E&gt; tailSet(E fromElement, boolean inclusive) {<a name="line.225"></a>
<span class="sourceLineNo">226</span>    return delegate().tailSet(fromElement, inclusive);<a name="line.226"></a>
<span class="sourceLineNo">227</span>  }<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span>  /**<a name="line.229"></a>
<span class="sourceLineNo">230</span>   * A sensible definition of {@link #tailSet(Object)} in terms of the<a name="line.230"></a>
<span class="sourceLineNo">231</span>   * {@link #tailSet(Object, boolean)} method. If you override<a name="line.231"></a>
<span class="sourceLineNo">232</span>   * {@link #tailSet(Object, boolean)}, you may wish to override<a name="line.232"></a>
<span class="sourceLineNo">233</span>   * {@link #tailSet(Object)} to forward to this implementation.<a name="line.233"></a>
<span class="sourceLineNo">234</span>   */<a name="line.234"></a>
<span class="sourceLineNo">235</span>  protected SortedSet&lt;E&gt; standardTailSet(E fromElement) {<a name="line.235"></a>
<span class="sourceLineNo">236</span>    return tailSet(fromElement, true);<a name="line.236"></a>
<span class="sourceLineNo">237</span>  }<a name="line.237"></a>
<span class="sourceLineNo">238</span>}<a name="line.238"></a>




























































</pre>
</div>
</body>
</html>
